User's Guide

Customizing Deployment Manager

You can customize some of the operational parameters of Deployment Manager using the properties file. The Properties file for NwDM on Windows NT is:

nways\java\properties\CfgManProperties.txt

where nways is the directory on the server where NwDM is installed.

The Properties file for NwDM on AIX is:

/usr/CML/JMA/java/properties/CfgManProperties.txt

Syntax Rules for Editing the Properties File

Follow these syntax rules when editing the Properties files:

Comment lines begin with the pound sign (#) as the first non-blank character on a line.
Parameters can be entered on multiple lines. To logically continue a line on the next line, use the backslash character (\) as the last character on the line to be continued.
The backslash character is a special character that gives the character following it special meaning. Therefore, if you need to use the backslash as a literal character, you must type two of them together (\\).
To specify directories in NwDM (for both Windows NT and AIX), you can use the forward slash character. For example, you can specify mydir as a subdirectory of the dir on the c: drive using this syntax:
c:/thedir/mydir

Property File Contents

You can configure these operational aspects of Deployment Manager:

Database
Working Directories
TFTP
Telnet
GUI Configuration Tools
Job Dispatching

You should have installed DB2 when you installed Nways Manager. In addition, you should have created a DB2 database for Deployment Manager. Refer to the Nways Manager Installation Guide (AIX or NT, depending upon your operating system) for more information about installing and setting up DB2.

Use these parameters to specify the database information to be used by NwDM:

JDBC Driver name. Specify the JDBC driver to be used.
CfgManUrl. Used to specify the name of the NwDM database. The default database name shipped with NwDM is CfgMan.
Database User ID. Specify the user ID used for the Nways topology database or leave the user ID blank.
User Password. Specify the user password to be used. If you left the user ID blank, leave this parameter blank as well.

Working Directories Parameters

Deployment Manager uses the parameters to control where files are stored during operation. Use these parameters to specify the working directories used by Nways Deployment Manager:

tempDirectory. Specify the location where NwDM can store temporary files during operation. The directory specified for this parameter must be a directory that exists. NwDM will control the deletion of files in this directory when the files are no longer needed.
logDirectory. Specify the directory where NwDM can store job logs (which provide details of job execution). The directory specified for this parameter must point to a directory that exists. The logs are stored in this directory using this file naming convention:
Job jobnumber.log. For example, job147.log

TFTP Parameters

Nways Deployment Manager uses a trivial file transfer protocol (TFTP) server to communicate with network devices. The TFTP server is used as a staging area for load images. For example, assume that you have fifteen 2210 devices located in South Carolina. You might have one TFTP server that connects with these devices. The TFTP server would contain the Load images and PROM code used in the servers or network devices (routers and switches). That way, you could always ensure that you have access to the appropriate load image and PROM code in the event a 2210 device experiences a problem.

NwDM is shipped with its own TFTP server for performing these functions. However, you can choose to use your own TFTP server instead.

The TFTP server can be used to:

Store device configurations (load images, configuration files, and PROM images)
Send device configurations to the device.
Receive device configurations from the device (or from another location).

TFTP functions are controlled by these parameters:

startTftpServer. Specify yes if you want to use the TFTP server shipped with NwDM, or no if you want to use your own TFTP server.
tftpMaxRetries. Specify the number of times the TFTP server retries a transfer before failing. This parameter is valid only for the TFTP server shipped with NwDM.
tftpTimeout. Specify the number of seconds that the TFTP server is to wait for an acknowledgment before retrying a transfer. This parameter is valid only for the TFTP server shipped with NwDM.
tftpInboundDir. Specify the directory on the TFTP server to be used by clients for operation put files. The directory you specify for this parameter will typically be the same as the directory you specify for tftpOutboundDir. If you do not use the TFTP server provided with Nways Deployment Manager, configure your TFTP server to put files into this directory by default.
tftpOutboundDir. Specify the directory on the TFTP server to be used by clients for get operation files. The directory you specify will typically be the same as the directory you specify for tftpInboundDir. If you do not use the TFTP server provided with NwDM, configure your TFTP server to send files from this directory by default.
localTftpClientAddr. Specify the local IP address that NwDM will use. If this parameter is blank, NwDM uses the first available IP address. If you have multiple network interface cards and your network routing prevents TFTP servers from reaching the IP addresses for all of them, specify an IP address that can be reached from TFTP servers.

Telnet Parameters

NwDM operates as a Telnet client for some operations performed on network devices. These parameters control the operation of NwDM when it serves as a Telnet client:

devCtl.NormalTimeout. Specify the number of seconds that NwDM will wait for a "quick" response from a client. If the NwDM job logs contain Telnet timeout errors for commands that normally execute very quickly, increase the value of this parameter.
devCtl.EraseTimeout. Specify the number of seconds that NwDM will wait for an erase command to complete. Remember that the completion of an erase command can take a log time. If the NwDM job logs contain Telnet timeout errors for erase commands, increase the value of this parameter.
devCtl.tftpGetTimeout. Specify the number of seconds that NwDM will wait for a device to receive a file from a TFTP server. If the NwDM job logs contain Telnet timeout errors for TFTP get or put commands, increase the value of this parameter.
dummyCdb. Reserved.

GUI Configuration Tool Parameters

Nways Deployment Manager allows you to upgrade configurations, which requires both the configuration tool for the existing configuration as well as the configuration tool for the new configuration. If you are using configuration tools that were originally shipped prior to July, 1998, you will need to run the Nways Manager Config Tool Locator to tell Deployment Manager where the older configuration tools are located. For more information about running the Config Tool Locator and working with device configuration programs, refer to the Nways Manager Installation Guide(AIX or NT, depending upon your operating system).

NwDM launches the GUI Configuration Tools with command-line arguments to perform version or release upgrades and to convert configuration files between ASCII and SRAM file formats. NwDM uses information from the GUI Configuration Tool installation to determine where the GUI Configuration Tools are located. Therefore, you should always use the installation program for a GUI Configuration Tool when you install it.

This parameter controls the operation of GUI Configuration Tools by Nways Deployment Manager:

cfgToolTimeToLive. Specify the number of seconds that you want NwDM to wait before halting the execution of a GUI Configuration Tool. When NwDM launches a GUI Configuration Tool, it sets a timer to determine how long the GUI Configuration Tool can process. If a GUI Configuration Tool has not completed processing before the timer expires, NwDM stops the processing.

Job Dispatching Parameters

You can use NwDM to schedule jobs for managing device configurations at times that are convenient for you. There is no limit on the number of jobs that you can schedule. However, if too many jobs are actually running at the same time, you risk overloading server or network resources.

This parameter controls the number of jobs that can be actually running at the same time.

maxJobsRunning. Specify the number of jobs that can be running at any given point in time. You can use this parameter to ensure that NwDM does not overload the server or the network with too much activity from the jobs that are running.

Sample Properties File

This is a sample of the Properties file as it is shipped:

# This is the CfgMan properties file
 
#The following are for DB/2 only
JdbcDriverName=COM.ibm.db2.jdbc.app.DB2Driver
CfgManUrl=jdbc:db2:CfgMan
 
 
CfgManUserId=admin
 
CfgManPassword=admin
 
CfgManSchema=CFGMAN
 
logDirectory=CfgMan/Logs
tempDirectory=CfgMan/Temp
 
useOwnWindowsCfgTool=yes
 
#------------------------------------------------
# TFTP Client and Server Properties
#------------------------------------------------
 
startTftpServer=yes
tftpMaxRetries=20
tftpTimeout=4
 
localTftpClientAddr=
tftpInboundDir=CfgMan/TftpSvrRoot
tftpOutboundDir=CfgMan/TftpSvrRoot
 
#------------------------------------------------
devCtl.NormalTimeout = 20
devCtl.EraseTimeout = 480
devCtl.tftpGetTimeout = 1800
 
dummyCdb=./dummy.cdb
 
cfgToolTimeToLive = 1800
 
maxJobsRunning = 10

[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]